Do we Really Need to Write Documentation for a System? - CASE Tool Add-ons: Generator+Editor for a Precise Documentation
نویسندگان
چکیده
One of the common problems of system development projects is that the system documentation is often outdated and does not describe the latest version of the system. The situation is even more complicated if we are speaking not about a natural language description of the system, but about its formal specification. In this paper we discuss how the problem could be solved by updating the documentation automatically, by generating a new formal specification from the model if the model is frequently changed.
منابع مشابه
A Hypertext System for Literate C++ Programming
Programs are written to be executed by computers rather than to be read by humans. This complicates program comprehension, which plays a major role in software maintenance. Literate programming is an approach to improve program understanding by regarding programs as works of literature (see [Knu84]). In this paper we present a tool that supports literate programming with the objectoriented prog...
متن کاملProse + Test Cases = Specifications
The rise of component-based software development has created a need for API documentation. Experience has shown that it is hard to create and maintain precise and readable documentation. Prose documentation can provide a good overview but lacks precision. Formal methods ooer precision but the resulting documentation is expensive to write and modify. Worse, few developers have the skill or incli...
متن کاملThe Vicinity of Program Documentation Tools
Program documentation plays a vital role in almost all programming processes. Program documentation flows between separate tools of a modularized environment, and in between the components of an integrated development environment as well. In this paper we discuss the flow of program documentation between program development tools. In the central part of the paper we introduce a mapping of docum...
متن کاملSGML - Lite { An SGML - based Programming Environment
Literate Programming is a documentation method that attempts to maintain consistency among the various design and program documents of a software system. Unfortunately the majority of the literate programming tools do not have appropriate user interfaces and require the users to learn complicated and cryptic tagging languages. SGML is a metalanguage used to specify markup or tagging languages t...
متن کاملDocumentu: a flexible architecture for documentation production based on a reverse-engineering strategy
Good documentation is essential to the production and evolution of quality software. Based on a survey on program documentation, we propose a documentation architecture that aims to fulfil several requirements of an ideal solution. The architecture integrates a powerful transformation system (Draco-PUC) and a versatile CASE tool (Talisman) in order to produce documents using reverse-engineering...
متن کامل